Salesforce UX API icon

Salesforce UX API

(0 reviews)

TMF622- LifelineDiscountPrepaid-PR

==> Create Lifeline Discount Enrollment for prepaid in Matrixx system (Rating system) POST:/productOrder

Note:

  • To work this lifline discount functionality “productCharacteristic.value.@type" should be pass “MtxParameterStringValue”.
  • you need to pass the LifelineDiscountEnrollment value as ‘True’ if you want to add Lifeline Discount for existing plan
  • please provide all parameter values (DataChargePercentage, VoiceChargePercentageIntra, VoiceChargePercentageInter, SmsChargePercentage, LifelineDiscountEnrollment) even if you want to add LifelineDiscountEnrollment only otherwise Matrixx system will take default value for missing parameters.
URL
https://[localhost]:[port]/sfdc-ux/v1/{businessId}/productOrder
url Param
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BB, JM, PA, PR, etc.) identifying the business unit.Y
nametypedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.
Y
channelIdstringThis is to identify the source (Project).Value : BUS sfdc-b2c Conditionally Mandatory. It is Mandatory only for B2B and B2C as there are underlying conditions based on channelId receivedY
targetSystemstringThis describes the end system request is for Eg: Aria, Matrixx.Note - For Peacock Mobile Project, it's mandatoryY
lobstringThis is tidentify line of business, exmaple POSTPAID, PREPAID.Y
cURL request
{
    "note": [
        {
            "text": "Change Plan",
            "@type": "ReasonCode"
        },
        {
            "text": "12345",
            "@type": "TransactionId"
        }
    ],
    "channel": [
        {
            "name": "SFDC-B2C"
        }
    ],
    "productOrderItem": [
        {
            "@type": "Subscription",
            "action": "noChange",
            "id": "01",
            "product": {
                "id": "S-1913223321",
                "name": "Prepaid Subscription",
                "status": "active",
                "@type": "Subscription"
            },
            "productOrderItem": [
                {
                    "id": "",
                    "action": "add",
                    "@type": "Offer",
                    "product": {
                        "id": "",
                        "name": "LLA: PPU Services: Prepaid",
                        "status": "active",
                        "@type": "Offer",
                        "productCharacteristic": [
                            {
                                "value": "BasePlan",
                                "name": "OfferType",
                                "@type": "Attr"
                            },
                            {
                                "value": "PR_B2C_Prepaid_16GB_Mobile_Line",
                                "name": "CommercialPlanCode",
                                "@type": "Attr"
                            },
                            {
                                "value": "Prepaid 16GB Mobile Line",
                                "name": "CommercialPlanName",
                                "@type": "Attr"
                            },
                            {
                                "value": "3743732456",
                                "name": "OrderItemId",
                                "@type": "Attr"
                            }
                        ]
                    }
                },
                {
                    "id": "",
                    "action": "add",
                    "@type": "Offer",
                    "product": {
                        "id": "",
                        "name": "LLA: Setup Services",
                        "status": "active",
                        "@type": "Offer",
                        "productCharacteristic": [
                            {
                                "value": "BasePlan",
                                "name": "OfferType",
                                "@type": "Attr"
                            },
                            {
                                "value": "PR_B2C_Prepaid_16GB_Mobile_Line",
                                "name": "CommercialPlanCode",
                                "@type": "Attr"
                            },
                            {
                                "value": "Prepaid 16GB Mobile Line",
                                "name": "CommercialPlanName",
                                "@type": "Attr"
                            },
                            {
                                "value": "3743732456",
                                "name": "OrderItemId",
                                "@type": "Attr"
                            }
                        ]
                    }
                },
                {
                    "@type": "Offer",
                    "action": "add",
                    "id": "01",
                    "product": {
                        "id": "",
                        "name": "Prepaid_Template_Shared",
                        "status": "active",
                        "@type": "Offer",
                        "productCharacteristic": [
                            {
                                "value": "BasePlan",
                                "name": "OfferType",
                                "@type": "Attr"
                            },
                            {
                                "value": "PR_B2C_Prepaid_16GB_Mobile_Line",
                                "@type": "Attr",
                                "name": "CommercialPlanCode"
                            },
                            {
                                "value": "Prepaid 16GB Mobile Line",
                                "name": "CommercialPlanName",
                                "@type": "Attr"
                            },
                            {
                                "value": "10.00",
                                "name": "TotalCharge",
                                "@type": "Attr"
                            },
                            {
                                "name": "ChargeMethod",
                                "value": "1"
                            },
                            {
                                "name": "RolloverSupported",
                                "@type": "Attr",
                                "value": "true"
                            },
                            {
                                "name": "DataGrant",
                                "@type": "Attr",
                                "value": "16384.00"
                            },
                            {
                                "name": "HotspotGrant",
                                "@type": "Attr",
                                "value": "16384.00"
                            },
                            {
                                "name": "VoiceGrant",
                                "@type": "Attr",
                                "value": "999999.00"
                            },
                            {
                                "name": "TextGrant",
                                "@type": "Attr",
                                "value": "999999.00"
                            },
                            {
                                "name": "MMSGrant",
                                "@type": "Attr",
                                "value": "999999.00"
                            },
                            {
                                "name": "VoiceOriginationLocations",
                                "@type": "Attr",
                                "value": [
                                    "0"
                                ]
                            },
                            {
                                "name": "VoiceDestinationLocations",
                                "@type": "Attr",
                                "value": [
                                    "0"
                                ]
                            },
                            {
                                "name": "TextOriginationLocations",
                                "@type": "Attr",
                                "value": [
                                    "1",
                                    "2",
                                    "3",
                                    "4",
                                    "5"
                                ]
                            },
                            {
                                "name": "TextDestinationLocations",
                                "@type": "Attr",
                                "value": [
                                    "1",
                                    "2",
                                    "3",
                                    "4",
                                    "5"
                                ]
                            },
                            {
                                "name": "MMSOriginationLocations",
                                "@type": "Attr",
                                "value": [
                                    "1",
                                    "2",
                                    "3",
                                    "4",
                                    "5"
                                ]
                            },
                            {
                                "name": "MMSDestinationLocations",
                                "@type": "Attr",
                                "value": [
                                    "1",
                                    "2",
                                    "3",
                                    "4",
                                    "5"
                                ]
                            },
                            {
                                "name": "DataOriginationLocations",
                                "@type": "Attr",
                                "value": [
                                    "1",
                                    "2",
                                    "3",
                                    "4",
                                    "5"
                                ]
                            },
                            {
                                "@type": "Attr",
                                "value": "10.00",
                                "name": "AutoPayDiscount"
                            },
                            {
                                "value": {
                                    "value": "0.280",
                                    "ParameterDefnId": "1",
                                    "@type": "MtxParameterDecimalValue"
                                },
                                "valueType": "Object",
                                "@type": "Parameter",
                                "name": "DataChargePercentage"
                            },
                            {
                                "value": {
                                    "value": "0.662",
                                    "ParameterDefnId": "10",
                                    "@type": "MtxParameterDecimalValue"
                                },
                                "valueType": "Object",
                                "@type": "Parameter",
                                "name": "VoiceChargePercentageIntra"
                            },
                            {
                                "value": {
                                    "value": "0.058",
                                    "ParameterDefnId": "11",
                                    "@type": "MtxParameterDecimalValue"
                                },
                                "valueType": "Object",
                                "@type": "Parameter",
                                "name": "VoiceChargePercentageInter"
                            },
                            {
                                "value": {
                                    "value": "0.0",
                                    "ParameterDefnId": "12",
                                    "@type": "MtxParameterDecimalValue"
                                },
                                "valueType": "Object",
                                "@type": "Parameter",
                                "name": "SmsChargePercentage"
                            },
                            {
                                "value": {
                                    "value": "True",
                                    "ParameterDefnId": "13",
                                    "@type": "MtxParameterStringValue"
                                },
                                "valueType": "Object",
                                "@type": "Parameter",
                                "name": "LifelineDiscountEnrollment"
                            }
                        ]
                    }
                }
            ]
        }
    ],
    "@type": "ProductOrder"
}
Definitions
nametypedescriptionrequired
notearrayExtra information about a given entityN
note.textstringText of the noteN
note.@typestringType of entityN
channelarrayRelated channel to another entity.N
channel.namestringName of the channel.N
productOrderItemarrayAn identified part of the order. A product order is decomposed into one or more order items.N
productOrderItem.idstringIdentifier of the line itemY
productOrderItem.actionstringaction to be performed on the product.
Note - expected value is "noChange"
Y
productOrderItem.@typestringType of orderItemN
productOrderItem.productobjectA product to be created defined by value or existing defined by reference.Y
productOrderItem.product.idstringSubscription external IdY
productOrderItem.product.namestringCatalog Item Name (ExternalId)N
productOrderItem.product.statusstringStatus of productN
productOrderItem.product.@typestringProduct typeN
productOrderItem.productOrderItemarrayAn identified part of the order. A product order is decomposed into one or more order items.Y
productOrderItem.productOrderItem.idstringIdentifier of the line item,
Note - ESB is not passing this value to Matrixx, it's mandatory as pr TMF guidelines. you can pass either empty or any random values
Y
productOrderItem.productOrderItem.actionstringaction to be performed on the product.
Note - expected value is "add"
Y
productOrderItem.productOrderItem.@typestringType of product order itemN
productOrderItem.productOrderItem.productobjectA product to be created defined by value or existing defined by reference.Y
productOrderItem.productOrderItem.product.idstringUnique identifier of the productN
productOrderItem.productOrderItem.product.namestringCatalog Item Name (ExternalId),
Note - ESB is not passing this value to Matrixx (backend system), it's mandatory as pr TMF guidelines. you can pass either empty or any random values
Y
productOrderItem.productOrderItem.product.statusstringStatus of productN
productOrderItem.productOrderItem.product.@typestringProduct typeY
productOrderItem.productOrderItem.product.productCharacteristicarrayDescribes a given characteristic of an object or entity through a name/value pair.
Pleases refer below productCharacteristic values for more info.
N
productOrderItem.productOrderItem.product.productCharacteristic.namestringName of the characteristicN
productOrderItem.productOrderItem.product.productCharacteristic.valuestringValue of the characteristicN
productOrderItem.productOrderItem.product.productCharacteristic.@typestringcharacteristic typeN
productCharacteristic Values
nametypedescriptionrequired
OfferTypestringOffer TypeN
CommercialPlanCodestringCommercial Plan CodeN
CommercialPlanNamestringCommercial Plan NameN
OrderItemIdstringOrder Item IdN
TotalChargestringOffer Total ChargeN
ChargeMethodstringCharge MethodN
RolloverSupportedstringRollover SupportedN
DataGrantstringData GrantN
HotspotGrantstringHotspot GrantN
VoiceGrantstringVoice GrantN
TextGrantstringText GrantN
MMSGrantstringMMS GrantN
VoiceOriginationLocationsarrayVoice Origination LocationsN
VoiceDestinationLocationsarrayVoice Destination LocationsN
TextOriginationLocationsarrayText Origination LocationsN
TextDestinationLocationsarrayText Destination LocationsN
MMSOriginationLocationsarrayMMS Origination LocationsN
MMSDestinationLocationsarrayMMS Destination LocationsN
DataOriginationLocationsarrayData Origination LocationsN
AutoPayDiscountstringAutoPay DiscountN
DataChargePercentageobjectData Charge PercentageN
VoiceChargePercentageIntraobjectVoice Charge PercentageIntraN
VoiceChargePercentageInterobjectVoice Charge PercentageInterN
SmsChargePercentageobjectSms Charge PercentageN
LifelineDiscountEnrollmentobjectLifeline Discount EnrollmentN
Note Values
nametypedescriptionrequired
TransactionIdstringunique Transaction IdN
ReasonCodestringReason of this transactionN
Response
{
    "state": "completed",
    "note": [
        {
            "text": "Change Plan",
            "@type": "ReasonCode"
        },
        {
            "text": "12345",
            "@type": "TransactionId"
        }
    ],
    "channel": [
        {
            "name": "SFDC-B2C"
        }
    ],
    "productOrderItem": [
        {
            "@type": "Subscription",
            "action": "noChange",
            "id": "01",
            "product": {
                "id": "S-1913223321",
                "name": "Prepaid Subscription",
                "status": "active",
                "@type": "Subscription"
            },
            "productOrderItem": [
                {
                    "id": "",
                    "action": "add",
                    "@type": "Offer",
                    "product": {
                        "id": "",
                        "name": "LLA: PPU Services: Prepaid",
                        "status": "active",
                        "@type": "Offer",
                        "productCharacteristic": [
                            {
                                "value": "BasePlan",
                                "name": "OfferType",
                                "@type": "Attr"
                            },
                            {
                                "value": "PR_B2C_Prepaid_16GB_Mobile_Line",
                                "name": "CommercialPlanCode",
                                "@type": "Attr"
                            },
                            {
                                "value": "Prepaid 16GB Mobile Line",
                                "name": "CommercialPlanName",
                                "@type": "Attr"
                            },
                            {
                                "value": "3743732456",
                                "name": "OrderItemId",
                                "@type": "Attr"
                            }
                        ]
                    }
                },
                {
                    "id": "",
                    "action": "add",
                    "@type": "Offer",
                    "product": {
                        "id": "",
                        "name": "LLA: Setup Services",
                        "status": "active",
                        "@type": "Offer",
                        "productCharacteristic": [
                            {
                                "value": "BasePlan",
                                "name": "OfferType",
                                "@type": "Attr"
                            },
                            {
                                "value": "PR_B2C_Prepaid_16GB_Mobile_Line",
                                "name": "CommercialPlanCode",
                                "@type": "Attr"
                            },
                            {
                                "value": "Prepaid 16GB Mobile Line",
                                "name": "CommercialPlanName",
                                "@type": "Attr"
                            },
                            {
                                "value": "3743732456",
                                "name": "OrderItemId",
                                "@type": "Attr"
                            }
                        ]
                    }
                },
                {
                    "@type": "Offer",
                    "action": "add",
                    "id": "01",
                    "product": {
                        "id": "",
                        "name": "Prepaid_Template_Shared",
                        "status": "active",
                        "@type": "Offer",
                        "productCharacteristic": [
                            {
                                "value": "BasePlan",
                                "name": "OfferType",
                                "@type": "Attr"
                            },
                            {
                                "value": "PR_B2C_Prepaid_16GB_Mobile_Line",
                                "@type": "Attr",
                                "name": "CommercialPlanCode"
                            },
                            {
                                "value": "Prepaid 16GB Mobile Line",
                                "name": "CommercialPlanName",
                                "@type": "Attr"
                            },
                            {
                                "value": "10.00",
                                "name": "TotalCharge",
                                "@type": "Attr"
                            },
                            {
                                "name": "ChargeMethod",
                                "value": "1"
                            },
                            {
                                "name": "RolloverSupported",
                                "@type": "Attr",
                                "value": "true"
                            },
                            {
                                "name": "DataGrant",
                                "@type": "Attr",
                                "value": "16384.00"
                            },
                            {
                                "name": "HotspotGrant",
                                "@type": "Attr",
                                "value": "16384.00"
                            },
                            {
                                "name": "VoiceGrant",
                                "@type": "Attr",
                                "value": "999999.00"
                            },
                            {
                                "name": "TextGrant",
                                "@type": "Attr",
                                "value": "999999.00"
                            },
                            {
                                "name": "MMSGrant",
                                "@type": "Attr",
                                "value": "999999.00"
                            },
                            {
                                "name": "VoiceOriginationLocations",
                                "@type": "Attr",
                                "value": [
                                    "0"
                                ]
                            },
                            {
                                "name": "VoiceDestinationLocations",
                                "@type": "Attr",
                                "value": [
                                    "0"
                                ]
                            },
                            {
                                "name": "TextOriginationLocations",
                                "@type": "Attr",
                                "value": [
                                    "1",
                                    "2",
                                    "3",
                                    "4",
                                    "5"
                                ]
                            },
                            {
                                "name": "TextDestinationLocations",
                                "@type": "Attr",
                                "value": [
                                    "1",
                                    "2",
                                    "3",
                                    "4",
                                    "5"
                                ]
                            },
                            {
                                "name": "MMSOriginationLocations",
                                "@type": "Attr",
                                "value": [
                                    "1",
                                    "2",
                                    "3",
                                    "4",
                                    "5"
                                ]
                            },
                            {
                                "name": "MMSDestinationLocations",
                                "@type": "Attr",
                                "value": [
                                    "1",
                                    "2",
                                    "3",
                                    "4",
                                    "5"
                                ]
                            },
                            {
                                "name": "DataOriginationLocations",
                                "@type": "Attr",
                                "value": [
                                    "1",
                                    "2",
                                    "3",
                                    "4",
                                    "5"
                                ]
                            },
                            {
                                "@type": "Attr",
                                "value": "10.00",
                                "name": "AutoPayDiscount"
                            },
                            {
                                "value": {
                                    "value": "0.280",
                                    "ParameterDefnId": "1",
                                    "@type": "MtxParameterDecimalValue"
                                },
                                "valueType": "Object",
                                "@type": "Parameter",
                                "name": "DataChargePercentage"
                            },
                            {
                                "value": {
                                    "value": "0.662",
                                    "ParameterDefnId": "10",
                                    "@type": "MtxParameterDecimalValue"
                                },
                                "valueType": "Object",
                                "@type": "Parameter",
                                "name": "VoiceChargePercentageIntra"
                            },
                            {
                                "value": {
                                    "value": "0.058",
                                    "ParameterDefnId": "11",
                                    "@type": "MtxParameterDecimalValue"
                                },
                                "valueType": "Object",
                                "@type": "Parameter",
                                "name": "VoiceChargePercentageInter"
                            },
                            {
                                "value": {
                                    "value": "0.0",
                                    "ParameterDefnId": "12",
                                    "@type": "MtxParameterDecimalValue"
                                },
                                "valueType": "Object",
                                "@type": "Parameter",
                                "name": "SmsChargePercentage"
                            },
                            {
                                "value": {
                                    "value": "True",
                                    "ParameterDefnId": "13",
                                    "@type": "MtxParameterStringValue"
                                },
                                "valueType": "Object",
                                "@type": "Parameter",
                                "name": "LifelineDiscountEnrollment"
                            }
                        ]
                    }
                }
            ]
        }
    ],
    "@type": "ProductOrder"
}
Definitions
nametypedescriptionrequired
statestringThe state of the orderN
Entire request payload will be appended with state in responseN

==> Modify Lifeline Discount Enrollment for prepaid in Matrixx system (Rating system) PATCH:/productOrder/{id}

Modify plan by adding/removing Lifeline Discount for an existing subscriber prepaid

Note:

  • To work this lifline discount functionality “productCharacteristic.value.@type" should be pass “MtxParameterStringValue”.
  • you need to pass the LifelineDiscountEnrollment value as ‘False’ to remove the Lifeline Discount. Else pass as ‘True’ if you want to add Lifeline Discount for existing plan
  • please provide all parameter values (DataChargePercentage, VoiceChargePercentageIntra, VoiceChargePercentageInter, SmsChargePercentage, LifelineDiscountEnrollment) even if you want to modify LifelineDiscountEnrollment only otherwise Matrixx system will take default value for missing parameters.
URL
https://[localhost]:[port]/sfdc-ux/v1/{businessId}/productOrder/{id}
URL PARAMS
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit.Y
idstringIdentifier of the Product OrderY
namevaluedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.Y
channeIdStringChannel to business:
Can be one of: "SFDC-B2C”, “SFDC-B2B"
Y
targetSystemStringThis describes the end system request is for Eg: “Aria”, “Matrixx”.Y
lobString
Request
curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/productOrder/S-12345' \
--header 'X-Correlation-Id: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'lob: PREPAID' \
--header 'channelId: SFDC-B2C' \
--header 'targetSystem: MATRIXX' \
--header 'client_id: 784c9a6dd7ae49768816cab57fcf1fa1' \
--header 'client_secret: 187b259EB77441babbF611d2646C670d' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channel": [
        {
            "name": "SFDC-B2C"
        }
    ],
    "note": [
        {
            "text": "Subscription Offer Modify",
            "@type": "ReasonCode"
        },
        {
            "text": "SFDC_TransactionID",
            "@type": "TransactionId"
        }
    ],
    "productOrderItem": [
        {
            "id": "",
            "action": "noChange",
            "@type": "Subscription",
            "product": {
                "id": "S-12345",
                "name": "Sub-ABC",
                "description": "Subscription for line 1",
                "status": "active",
                "@type": "Subscription"
            },
            "productOrderItem": [
                {
                    "id": "",
                    "action": "modify",
                    "@type": "offer",
                    "product": {
                        "id": "123",
                        "name": "Prepaid_Template_Shared",
                        "status": "active",
                        "@type": "offer",
                        "productCharacteristic": [
                            {
                                "name": "DataChargePercentage",
                                "@type": "Parameter",
                                "valueType": "Object",
                                "value": {
                                    "ParameterDefnId": "1",
                                    "value": "0.280"
                                }
                            },
                            {
                                "name": "VoiceChargePercentageIntra",
                                "@type": "Parameter",
                                "valueType": "Object",
                                "value": {
                                    "ParameterDefnId": "10",
                                    "value": "0.662"
                                }
                            },
                            {
                                "name": "VoiceChargePercentageInter",
                                "@type": "Parameter",
                                "valueType": "Object",
                                "value": {
                                    "ParameterDefnId": "11",
                                    "value": "0.058"
                                }
                            },
                            {
                                "name": "SmsChargePercentage",
                                "@type": "Parameter",
                                "valueType": "Object",
                                "value": {
                                    "ParameterDefnId": "12",
                                    "value": "0.0"
                                }
                            },
                            {
                                "name": "LifelineDiscountEnrollment",
                                "@type": "Parameter",
                                "valueType": "Object",
                                "value": {
                                    "ParameterDefnId": "13",
                                    "value": "True"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ],
    "@type": "ProductOrder"
}'
Definitions
nametypedescriptionrequired
notearrayExtra information about a given entityN
note.textstringText of the noteN
note.@typestringType of entityN
channelarrayRelated channel to another entity.N
channel.namestringName of the channel.N
productOrderItemarrayAn identified part of the order. A product order is decomposed into one or more order items.N
productOrderItem.idstringIdentifier of the line itemY
productOrderItem.actionstringaction to be performed on the product.
Note - expected value is "noChange"
N
productOrderItem.@typestringType of orderItemN
productOrderItem.productobjectA product to be created defined by value or existing defined by reference.Y
productOrderItem.product.idstringSubscription external IdY
productOrderItem.product.namestringCatalog Item Name (ExternalId)N
productOrderItem.product.statusstringStatus of productN
productOrderItem.product.@typestringProduct typeN
productOrderItem.productOrderItemarrayAn identified part of the order. A product order is decomposed into one or more order items.Y
productOrderItem.productOrderItem.idstringIdentifier of the line item,
Note - ESB is not passing this value to Matrixx, it's mandatory as pr TMF guidelines. you can pass either empty or any random values
Y
productOrderItem.productOrderItem.actionstringaction to be performed on the product.
Note - expected value is "add"
N
productOrderItem.productOrderItem.@typestringType of product order itemN
productOrderItem.productOrderItem.productobjectA product to be created defined by value or existing defined by reference.Y
productOrderItem.productOrderItem.product.idstringUnique identifier of the productN
productOrderItem.productOrderItem.product.namestringCatalog Item Name (ExternalId),
Note - ESB is not passing this value to Matrixx (backend system), it's mandatory as pr TMF guidelines. you can pass either empty or any random values
Y
productOrderItem.productOrderItem.product.statusstringStatus of productN
productOrderItem.productOrderItem.product.@typestringProduct typeY
productOrderItem.productOrderItem.product.productCharacteristicarrayDescribes a given characteristic of an object or entity through a name/value pair.
Pleases refer below productCharacteristic values for more info.
N
productOrderItem.productOrderItem.product.productCharacteristic.namestringName of the characteristicN
productOrderItem.productOrderItem.product.productCharacteristic.valuestringValue of the characteristicN
productOrderItem.productOrderItem.product.productCharacteristic.@typestringcharacteristic typeN
productCharacteristic Values
nametypedescriptionrequired
DataChargePercentageobjectData Charge PercentageN
VoiceChargePercentageIntraobjectVoice Charge PercentageIntraN
VoiceChargePercentageInterobjectVoice Charge PercentageInterN
SmsChargePercentageobjectSms Charge PercentageN
LifelineDiscountEnrollmentobjectLifeline Discount EnrollmentN
Note Values
nametypedescriptionrequired
TransactionIdstringunique Transaction IdN
ReasonCodestringReason of this transactionN
Response
{
    "state": "completed",
    "channel": [
        {
            "name": "SFDC-B2C"
        }
    ],
    "note": [
        {
            "text": "Subscription Offer Modify",
            "@type": "ReasonCode"
        },
        {
            "text": "SFDC_TransactionID",
            "@type": "TransactionId"
        }
    ],
    "productOrderItem": [
        {
            "id": "",
            "action": "noChange",
            "@type": "Subscription",
            "product": {
                "id": "S-12345",
                "name": "Sub-ABC",
                "description": "Subscription for line 1",
                "status": "active",
                "@type": "Subscription"
            },
            "productOrderItem": [
                {
                    "id": "",
                    "action": "modify",
                    "@type": "Offer",
                    "product": {
                        "id": "123",
                        "name": "Prepaid_Template_Shared",
                        "status": "active",
                        "@type": "Offer",
                        "productCharacteristic": [
                            {
                                "name": "DataChargePercentage",
                                "@type": "Parameter",
                                "valueType": "Object",
                                "value": {
                                    "ParameterDefnId": "1",
                                    "value": "0.280"
                                }
                            },
                            {
                                "name": "VoiceChargePercentageIntra",
                                "@type": "Parameter",
                                "valueType": "Object",
                                "value": {
                                    "ParameterDefnId": "10",
                                    "value": "0.662"
                                }
                            },
                            {
                                "name": "VoiceChargePercentageInter",
                                "@type": "Parameter",
                                "valueType": "Object",
                                "value": {
                                    "ParameterDefnId": "11",
                                    "value": "0.058"
                                }
                            },
                            {
                                "name": "SmsChargePercentage",
                                "@type": "Parameter",
                                "valueType": "Object",
                                "value": {
                                    "ParameterDefnId": "12",
                                    "value": "0.0"
                                }
                            },
                            {
                                "name": "LifelineDiscountEnrollment",
                                "@type": "Parameter",
                                "valueType": "Object",
                                "value": {
                                    "ParameterDefnId": "13",
                                    "value": "True"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ],
    "@type": "ProductOrder"
}
Definitions
nametypedescriptionrequired
statestringThe state of the orderN
Entire request payload will be appended in responseN

Reviews